/*
 * Copyright 2012-2021 the original author or authors.
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *      https://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

package org.springframework.boot.autoconfigure.condition;

import java.lang.annotation.Annotation;
import java.lang.annotation.Documented;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

import org.springframework.beans.factory.BeanFactory;
import org.springframework.context.annotation.Conditional;

/**
 * {@link Conditional @Conditional} 条件注解，仅当指定的 bean 类型在 {@link BeanFactory} 中不存在时匹配。
 * 条件要求指定的所有类型的 bean 都不存在，且这些条件不必由同一个 bean 满足。
 * <p>
 * 当用在 {@code @Bean} 方法上时，默认会以该工厂方法的返回类型作为 bean 类型：
 *
 * <pre class="code">
 * &#064;Configuration
 * public class MyAutoConfiguration {
 *
 *     &#064;ConditionalOnMissingBean
 *     &#064;Bean
 *     public MyService myService() {
 *         ...
 *     }
 *
 * }</pre>
 * <p>
 * 上例中条件匹配的含义是：如果 {@code MyService} 类型的 bean 不存在于 {@link BeanFactory} 中。
 * <p>
 * 该条件只匹配当前应用上下文已处理的 bean 定义，因此强烈建议仅在自动配置类中使用此条件。
 * 若有其他自动配置可能创建候选 bean，请确保本条件所用自动配置后执行。
 *
 * @author Phillip Webb
 * @author Andy Wilkinson
 * @since 1.0.0
 */
@Target({ ElementType.TYPE, ElementType.METHOD })
@Retention(RetentionPolicy.RUNTIME)
@Documented
@Conditional(OnBeanCondition.class)
public @interface ConditionalOnMissingBean {

	/**
	 * 要检查的 bean 类型。只有当 {@link BeanFactory} 中不存在指定类型的 bean 时，条件才匹配。
	 * @return 要检查的 bean 类型数组
	 */
	Class<?>[] value() default {};

	/**
	 * 要检查的 bean 类型全限定名。只有当 {@link BeanFactory} 中不存在指定类型的 bean 时，条件才匹配。
	 * @return 要检查的 bean 类型名称数组
	 */
	String[] type() default {};

	/**
	 * 在匹配时应忽略的 bean 类型。
	 * @return 要忽略的 bean 类型数组
	 * @since 1.2.5
	 */
	Class<?>[] ignored() default {};

	/**
	 * 在匹配时应忽略的 bean 类型名称。
	 * @return 要忽略的 bean 类型名称数组
	 * @since 1.2.5
	 */
	String[] ignoredType() default {};

	/**
	 * 需检查的 bean 上的注解类型。当指定的注解不存在于所有 bean 上时，条件匹配。
	 * @return 要检查的类级注解类型数组
	 */
	Class<? extends Annotation>[] annotation() default {};

	/**
	 * 需检查的 bean 名称。当指定的 bean 名称在 {@link BeanFactory} 中不存在时，条件匹配。
	 * @return 需要检查的 bean 名称数组
	 */
	String[] name() default {};

	/**
	 * 决定是否考虑应用上下文层级结构（父上下文）的搜索策略。
	 * @return 搜索策略枚举值
	 */
	SearchStrategy search() default SearchStrategy.ALL;

	/**
	 * 额外指定可能包含目标泛型类型的容器类。
	 * 例如，某注解声明 {@code value=Name.class} 且 {@code parameterizedContainer=NameRegistration.class}，
	 * 则既可检测 {@code Name}，也可检测 {@code NameRegistration<Name>}。
	 * @return 容器类型数组
	 * @since 2.1.0
	 */
	Class<?>[] parameterizedContainer() default {};

}
